.TH aurora 1 "13 Mar 2010" aurora "aurora"
.SH NAME
\fBaurora\fP \- communicate with an Aurora Magnetek Photovoltaic (solar) Power Inverter

.SH SYNOPSIS
.BI "aurora [Options] -a InverterAddress Device"

.SH "REQUIRED PARAMETERS"
.TP
.B -a, --address=num
Inverter address. (1-31)
.TP
.B Device
Serial Device.  Example, \fI/dev/ttyUSB0\fP or \fI/dev/ttyS0\fP.

.SH OPTIONS
.TP
.B -A, --last-alarms
Get last four alarms (once displayed FIFO queue is cleared)
.TP
.B -b, --verbose
Verbose mode
.TP
.B -C, --calc-value=num
Calculate $ value using num * KWh
.TP
.B -c, --columnize
Output data in columns --> for -d, -e, -D, -E options only, will disable all other options -- if value ends with an "*" reporting of that item may not be in inverters firmware
.TP
.B -d, --get-dsp
Get DSP data
.TP
.B -D, --get-dsp-extended
Get more DSP data
.TP
.B -e, --get-energy
Get Cumulated Energy readings
.TP
.B -E, --get-dsp-3phase
Get 3-Phase DSP data
.TP
.B -f, --firmware-ver
Query for Firmware Version string
.TP
.B -g, --mfg-date
Query for Inverter Manufacturing Date
.TP
.B -h, --help
This text
.TP
.B -i, --get-count
Display Inverter Time Counters
.TP
.B -j, --get-joules
Display Energy cumulated in the last 10 seconds
.TP
.B -l, --delay=num
Cmd Delay in 1/10ths seconds. Default is 1 (0.1 sec)
.TP
.B -m, --get-conf
Query for Inverter System Configuration
.TP
.B -n, --serial-number
Query for Inverter Serial Number
.TP
.B -o, --output-file=<filename>
Append data to file (Created if nonexistant)
.TP
.B -p, --part-number
Query for Inverter Part Number
.TP
.B
-P, --comm-pause=num
Wait <num> uS between sending commands to inverter (1-1000000)
.TP
.B -R, --read-timeout=num
Timeout value when reading data from the Inverter (mS)
.TP
.B -r, --calc-grid-power
Calc Grid power using Grid Voltage * Grid Current, instead of reporting the Inverter's value. --> for -d option only, ignored when used with -c option.  (Inverter typically reports a lower value. This affects Inverter conversion efficiency value.)
.TP
.B -S, --set-time
Set Inverter Date/Time to system time
.TP
.B -s, --get-state
Get Inverter State
.TP
.B -T, --get-loctime
Display computer Date/Time
.TP
.B -t, --get-invtime
Display Inverter Date/Time
.TP
.B -U, --read-pause=num
Pause 'num' milli-seconds after sending command to inverter before reading response from inverter (1-10000)
.TP
.B -u, --rpt-read-pause
Report when/that pausing before read
.TP
.B -V, --version
Aurora communications program version
.TP
.B -v, --inv-version
Query for Version string
.TP
.B -w, --lock-wait
Seconds to wait to lock serial port. (1-30)
.TP
.B -x, --xon-xoff
Enable XON/XOFF on the serial port.
.TP
.B -Y, --retries=num
Retry failed communications with inverter up to 'num' times (1-100)
.TP
.B -y, --rpt-retries
Report the number of retires done

.SH DESCRIPTION
\fBaurora\fP is a program that communicates with Aurora Magnetek Photovoltaic (solar) Power Inverters written by Curt Blank.  It can retrieve data and statistics from a variety of Aurora Inverters through either USB or Serial interfaces.

.SH EXAMPLES

aurora -T -c -e -d -a 2 -w 15 /dev/ttyS0

aurora -Y 100 -T -a 2 -w 10 -e /dev/ttyUSB0

.SH "SEE ALSO"
.TP
\fIhttp://www.curtronics.com/Solar/AuroraData.html\fP
.PD

.SH AUTHOR
This manpage was written by Dustin Kirkland <kirkland@canonical.com> and updated by Curt Blank <solar@curtronics.com> for Ubuntu systems (but may be used by others).  Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.
